/* ==================================================================
 * GpsModelAccessor.java - 8/07/2023 9:35:59 am
 * 
 * Copyright 2023 SolarNetwork.net Dev Team
 * 
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 of 
 * the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ==================================================================
 */

package net.solarnetwork.node.hw.sunspec.environmental;

import java.math.BigDecimal;
import java.time.Instant;
import net.solarnetwork.node.hw.sunspec.ModelAccessor;

/**
 * API for accessing GPS model data.
 * 
 * @author matt
 * @version 1.0
 * @since 4.2
 */
public interface GpsModelAccessor extends ModelAccessor {

	/**
	 * Get the GPS timestamp.
	 * 
	 * @return the timestamp
	 */
	Instant getGpsTimestamp();

	/**
	 * Get a location name.
	 * 
	 * @return the location name
	 */
	String getLocationName();

	/**
	 * Get the latitude, in decimal degrees.
	 * 
	 * @return the latitude
	 */
	BigDecimal getLatitude();

	/**
	 * Get the longitude, in decimal degrees.
	 * 
	 * @return the longitude
	 */
	BigDecimal getLongitude();

	/**
	 * Get the altitude, in meters.
	 * 
	 * @return the altitude
	 */
	Integer getAltitude();

}
